3.10 Canceling credentials and jobs

You can cancel credentials (for example, smart cards) and jobs using the CMSCardRequest method through the import service.

Note: If you want to cancel credentials or jobs, you do not have to include a Card node unless you also want to request a card at the same time.

3.10.1 Canceling cards

To cancel all of a user's credentials, pass an ApplicantAction of CancelDevices; for example:

<Actions>
  <ApplicantAction>CancelDevices</ApplicantAction>
  <StatusMappingID>ID</StatusMappingID>
  <RevocationComment>Comment</RevocationComment>
</Actions>

To cancel a specific credential, pass an ApplicantAction of CancelDevice. To identify the card you must include a Device node containing the card's serial number and device type.

You can cancel more than one credential in a single request by including more than one Device element.

Because not all systems track the serial number of the card, you can use a lookup mechanism to identify the card. For each field you want to look up, include the following:

<DeviceIdentifier>
  <SerialNumber>[identifier]</SerialNumber>
  <SerialNumberField>[field to look up]</SerialNumberField>
</DeviceIdentifier>

The field can be the name of any field present in the vDevices view; for example, SerialNumber for the standard card serial number, or HIDSerialNumber for the HID serial number. You can have multiple DeviceIdentifier nodes for each device.

Note: If you do not include a SerialNumberField node, MyID will use a default value of SerialNumber.

For example, to cancel a card with HIDSerialNumber0011778, pass through the following:

<Actions>
  <ApplicantAction>CancelDevice</ApplicantAction>
  <StatusMappingID>ID</StatusMappingID>
  <RevocationComment>Comment</RevocationComment>
  <Device>
    <DeviceIdentifier>
      <SerialNumber>0011778</SerialNumber>
      <SerialNumberField>HIDSerialNumber</SerialNumberField>
    </DeviceIdentifier>
  </Device>
</Actions>

You can cancel only the cards associated with the applicant. You can cancel suspended cards. You must pass the fields StatusMappingID and RevocationComment as normal.

3.10.2 Canceling jobs

To cancel all a user's jobs, pass an ApplicantAction of CancelAllJobs; for example:

<Actions>
  <ApplicantAction>CancelAllJobs</ApplicantAction>
</Actions>

Note: If the card is currently being processed by the bureau, the job is failed instead of canceled.

To cancel a single job, use an ApplicantAction of CancelJob, then include a <Job> node containing the ID of the job to cancel; for example:

<Actions>
  <ApplicantAction>CancelJob</ApplicantAction>
  <Job>12345</Job>
</Actions>

You can use the Reporting Web Service API to query the Jobs table to find the ID, or use Project Designer to create a custom MI Report that includes the ID in the list of jobs.

3.10.3 Filtering job cancellations

The feature to filter job cancellations using criteria is now "End of Life". The Filters node remains in the Lifecycle API schema, but cannot be used.

To cancel a specific job, use an ApplicantAction of CancelJob. See section 3.10.2, Canceling jobs for details.